org.eclipse.vtp.framework.interactions.voice.vxml
Class InlineGrammar

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.support.Widget
      org.eclipse.vtp.framework.interactions.voice.vxml.Grammar
          org.eclipse.vtp.framework.interactions.voice.vxml.InlineGrammar

All Implemented Interfaces:

VXMLConstants

public class InlineGrammar
extends Grammar

The InlineGrammar class represents the <grammar> VXML element with the grammar structure embedded as child elements.

Version:

2.0

Author:

Trip Gilman, Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.interactions.voice.vxml.VXMLConstants

EMPTY, FILE_EXT_GSL, FILLED_MODE_ALL, FILLED_MODE_ANY, GRAMMAR_MODE_DTMF, GRAMMAR_MODE_VOICE, METHOD_GET, METHOD_POST, MIME_TYPE_GSL, MIME_TYPE_SRGS, NAME_APPLICATION, NAME_ASSIGN, NAME_AUDIO, NAME_BARGEIN, NAME_BEEP, NAME_BLOCK, NAME_BRIDGE, NAME_CATCH, NAME_CHOICE, NAME_COMPLETETIMEOUT, NAME_COND, NAME_CONFIDENCELEVEL, NAME_COUNT, NAME_DEST, NAME_DISCONNECT, NAME_DTMF, NAME_DTMFTERM, NAME_ELSE, NAME_ELSEIF, NAME_ENCTYPE, NAME_ENUMERATE, NAME_ERROR, NAME_EVENT, NAME_EVENTEXPR, NAME_EXIT, NAME_EXPR, NAME_FIELD, NAME_FILLED, NAME_FINALSILENCE, NAME_FORM, NAME_GOTO, NAME_GRAMMAR, NAME_ID, NAME_IF, NAME_INCOMPLETETIMEOUT, NAME_INPUTMODES, NAME_INTERDIGITTIMEOUT, NAME_ITEM, NAME_MAXNBEST, NAME_MAXSPEECHTIMEOUT, NAME_MAXTIME, NAME_MENU, NAME_METHOD, NAME_MODE, NAME_NAME, NAME_NAMELIST, NAME_NEXT, NAME_NOINPUT, NAME_NOMATCH, NAME_ONE_OF, NAME_OPTION, NAME_PARAM, NAME_PROMPT, NAME_PROPERTY, NAME_RECORD, NAME_REPEAT, NAME_REPROMPT, NAME_RETURN, NAME_ROOT, NAME_RULE, NAME_SCOPE, NAME_SCRIPT, NAME_SENSITIVITY, NAME_SPEEDVSACCURACY, NAME_SRC, NAME_SUBDIALOG, NAME_SUBMIT, NAME_TERMCHAR, NAME_TERMTIMEOUT, NAME_THROW, NAME_TIMEOUT, NAME_TRANSFER, NAME_TYPE, NAME_VALUE, NAME_VAR, NAME_VERSION, NAME_VXML, NAMESPACE_URI_VXML, QNAME_XML_LANG, SCOPE_DIALOG, SCOPE_DOCUMENT, TYPE_CDATA, VERSION_2_0

Constructor Summary

InlineGrammar(java.lang.String mode)
Creates a new InlineGrammar.

Method Summary

void	addRule(Rule rule) Adds a rule to this grammar's list.
Rule[]	getRules() Returns the list of rules in this grammar.
void	removeRule(Rule rule) Removes a rule from this grammar's list.
protected void	writeAttributes(org.xml.sax.helpers.AttributesImpl attributes) Write the attribute members of this grammar to the supplied set.
protected void	writeChildren(org.xml.sax.ContentHandler outputHandler) Write the children(if any) of this grammar to the specified content handler.

Methods inherited from class org.eclipse.vtp.framework.interactions.voice.vxml.Grammar

getMode, setMode, writeWidget

Methods inherited from class org.eclipse.vtp.framework.interactions.core.support.Widget

toString, writeAttribute, writeChildren, writeChildren, writeWidget, writeWidget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InlineGrammar

public InlineGrammar(java.lang.String mode)
              throws java.lang.IllegalArgumentException,
                     java.lang.NullPointerException

Creates a new InlineGrammar.

Throws:

java.lang.IllegalArgumentException - If the specified mode is not one of "dtmf" or "voice".

java.lang.NullPointerException - If the specified mode is null.

Method Detail

getRules

public Rule[] getRules()

Returns the list of rules in this grammar.

Returns:

The list of rules in this grammar.

addRule

public void addRule(Rule rule)
             throws java.lang.NullPointerException

Adds a rule to this grammar's list.

Parameters:

rule - The rule to add.

Throws:

java.lang.NullPointerException - If the specified rule is null.

removeRule

public void removeRule(Rule rule)
                throws java.lang.NullPointerException

Removes a rule from this grammar's list.

Parameters:

rule - The rule to remove.

Throws:

java.lang.NullPointerException - If the specified rule is null.

writeAttributes

protected void writeAttributes(org.xml.sax.helpers.AttributesImpl attributes)

Description copied from class: Grammar

Write the attribute members of this grammar to the supplied set.

Overrides:

writeAttributes in class Grammar

Parameters:

attributes - The attribute set to write to.

writeChildren

protected void writeChildren(org.xml.sax.ContentHandler outputHandler)
                      throws java.lang.NullPointerException,
                             org.xml.sax.SAXException

Description copied from class: Grammar

Write the children(if any) of this grammar to the specified content handler.

Overrides:

writeChildren in class Grammar

Parameters:

outputHandler - The content handler to write to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of one of the children fails.